Developer Guide (API Reference) > Properties Files > jrunner.properties > Settings |
Important - Always use / as directory separator, even on Windows platform. |
Parameter | Default Value |
jrunner.java.command |
Java Application for 32-bit or 64-bit OS. (Do not change this) Default value for 32-bit OS: ../jre6/jre6-windows-x86-32/bin/java.exe Default value for 64-bit OS: ../jre6/jre6-windows-x86-64/bin/java.exe |
jrunner.java.mainclass |
Java Main class. (Do not change this) Default value: com.adeptol.JRunner |
jrunner.working.dir |
Working directory that is used after jrunner is initialized. (Do not change this) Default value: ./ |
jrunner.app.parameter.1 |
Application parameters, starting from 1. (Do not change this) Default value: proxyconfig=../conf/proxyserver_jar.properties |
jrunner.java.initmemory |
Initial Java heap size (in MB). Default value: 256 Maximum value 32-bit OS: 4096 (4 GB) Maximum value 64-bit OS: 262144 (256 GB) Note: Java process will fail to start if the memory specified by this parameter cannot be allocated. |
jrunner.java.maxmemory |
Maximum Java Heap Size (in MB). Default value 32-bit OS: 512 Default value 64-bit OS: 1024 Maximum value 32-bit OS: 4096 (4 GB) Maximum value 64-bit OS: 262144 (256 GB) |
jrunner.shutdown.timeout |
Maximum timeout to wait for the process shutdown. Default Value: 120 |
jrunner.jvm_exit.timeout |
Maximum timeout to wait for JVM to shutdown. Default Value: 120 |
jrunner.java.library.path.1 |
The first library path element. (Do not change this) Default value: ./ |
jrunner.java.library.path.2 |
The second java library path element, add additional path elements as needed starting from 3. (Do not change this) Default value: ./ |
jrunner.java.additional.1 |
Path for Java temporary directory. Default value: -Djava.io.tmpdir=%ALLUSERSPROFILE%/Accusoft/Prizm/work |
jrunner.java.additional.2 |
Parameter to enable headless mode for JRE. This mode does not require a DISPLAY connection on a Linux environment. Default value: -Djava.awt.headless=true |
jrunner.console.format |
Logging Properties. Format of output for the CONSOLE The format consists of the tokens: If the format contains these values then it will be included in the format. The order of the tokens does not affect the way the log appears, but the 'M' token should usually be placed last as it is the only column without a uniform width. If the property is missing or commented out, then the default value 'LPTM' will be used. Setting the property to a blank value will cause file logging to be disabled. Default value: LPZM Logs are created under <prizm-install>/logs directory. |
jrunner.console.loglevel |
The Valid log levels are: Default value: INFO Logs are created under <prizm-install>/logs directory. |
jrunner.logfile |
Log file to use for jRunner output logging. Either relative to jrunner.working.dir or full path. The specified log file name may contain one or both of the tokens: ROLLNUM or YYYYMMDD. Use ROLLNUM token if you want your log file to be rolled. The most recent log file will have the roll number of “1”, the second recent log file will have the roll number “2”, etc. Example for proxyserver.log.ROLLNUM: proxyserver.log.1, proxyserver.log.2, proxyserver.log.3, … Use YYYYMMDD token if you want your log file name to contain current date of the log file entries. Using this token requires also following setting of property value: jrunner.logfile.rollmode=DATE Default value: ../logs/proxyserver-YYYYMMDD.log |
jrunner.logfile.rollmode |
Roll mode of the log file specified by jrunner.logfile property. Following values can be set for log file rolling mode: NONE – the log file will never be rolled. SIZE – the log file will be rolled as soon as its size exceeds the value specified in the by the jrunner.logfile.maxsize property. JVM – the log file will be rolled on every restart of Java virtual machine (JVM). SIZE_OR_JVM – the log file will be rolled on every restart of JVM or when its size exceeds the size specified in the jrunner.logfile.maxsize property. DATE – use this property value when jrunner.logfile contains YYYYMMDD token. Note a log file will not be created on the days that have no logging output. Default value: DATE |
jrunner.logfile.format |
Log file format for jRunner output logging. Default value: LPTM |
jrunner.logfile.loglevel |
Log file log level for jRunner output logging. Default value: INFO |
jrunner.logfile.maxsize |
Maximum size that the log file will be allowed to grow to before the log is rolled. Size is specified in bytes. The default value of 0, disables log rolling. May abbreviate with the 'k' (kb) or 'm' (mb) suffix. For example, 10m = 10 megabytes. Default value: 0 |
jrunner.logfile.maxfiles |
Maximum number of rolled log files which will be allowed before old files are deleted, or a value of 0 to keep all log files forever. Default value: 7 |
jrunner.syslog.loglevel |
Log Level for sys/event log output. Default value: NONE |
jrunner.console.title |
Title to use when running as a console. Default value: Convert2SWF Proxy Server Console |
jrunner.ntservice.name |
Name of the Prizm Server service. Default value: Convert2SWFSvc |
jrunner.ntservice.displayname |
Display name of the service. Default value: Prizm |
jrunner.ntservice.description |
Description of the Prizm Server service. Run Convert2SWF Proxy Server Service helper for converting documents to PNG format |
jrunner.ntservice.dependency.1 |
Prizm Server service dependencies. Add dependencies as needed starting from 1. Default Value: blank (no value) |
jrunner.ntservice.starttype |
Mode in which the Prizm Server service is installed. Possible values are: AUTO_START or DEMAND_START. Default Value: AUTO_START |
jrunner.ntservice.interactive |
Allow the Prizm Server service to interact with the desktop. Possible values are: true, false. Default value: false |
jrunner.ntservice.account |
User account name under which the Prizm Server service runs. The value is set by installer script as specified by the user. |
jrunner.ntservice.password |
Password of the account under which the Prizm Server service runs. The value is set by installer script as specified by the user. |
jrunner.filter.trigger.1 |
Definition of the string in logfile triggering the action (1). (Do not change this) Default value: java.lang.OutOfMemoryError |
jrunner.filter.action.1 |
Action to be performed when triggering string (1) is found in logfile. (Do not change this) Default value: RESTART |
jrunner.filter.trigger.2 |
Definition of the string in logfile triggering the action (2). (Do not change this) Default value: jvm restart now |
jrunner.filter.action.2 |
Action to be performed when triggering string (2) is found in logfile. (Do not change this) Default value: RESTART |
jrunner.license.type |
Jrunner wrapper license type. (Do not change this) Default value: DEV |
jrunner.license.id |
Jrunner wrapper license type. (Do not change this) Default value: 201110060018 |
jrunner.license.licensee |
Jrunner wrapper license type. (Do not change this) Default value: ADEPTOL LLC |
jrunner.license.dev_application |
Jrunner wrapper license type. (Do not change this) Default value: Adeptol |
jrunner.license.features |
Jrunner wrapper license type. (Do not change this) Default value: 64bit |
jrunner.license.key.0 |
Jrunner wrapper license type. (Do not change this) Default value: 4ad7-38f0-5093-dff0 |
jrunner.license.key.1 |
Jrunner wrapper license type. (Do not change this) Default value: 296e-1eb2-d7ff-74cf |
jrunner.license.key.2 |
Jrunner wrapper license type. (Do not change this) Default value: 9916-ab7c-ce5e-78ce |
jrunner.license.key.3 |
Jrunner wrapper license type. (Do not change this) Default value: 0b4e-5cfd-b378-3c17 |
jrunner.license.key.4 |
Jrunner wrapper license type. (Do not change this) Default value: 5b95-f126-f567-ed1f |
jrunner.ping.interval |
Sets the ping interval to check if JVM is running (in seconds). The value should be from 1 to 3600 seconds and also 5 seconds less than the value of jrunner.ping.timeout.
|
jrunner.ping.timeout |
Sets the ping interval after which JVM is restarted when it is unresponsive. The value should be from 1 to 86400 seconds and it must be at least 5 seconds longer than the value of jrunner.ping.interval. Default value: 30 |
jrunner.ping.interval.logged |
Sets the ping interval log entry (in seconds). It is the time interval between ping requests which will be logged. The value should be from 1 to 86400 seconds. The ping logging is visible only when the loglevel is set to DEBUG. Default value: 1 |
Example for better logging for issue debugging:
# Log Level for console output.
jrunner.console.loglevel=DEBUG
# Log file to use for jRunner output logging
jrunner.logfile.rollmode=SIZE_OR_JVM
jrunner.logfile=../logs/proxyserver-YYYYMMDD.ROLLNUM.log
# Log Level for log file output.
jrunner.logfile.loglevel=DEBUG
# Maximum size that the log file will be allowed to grow before the log is rolled
jrunner.logfile.maxsize=150m
Setting jRunner to be less sensitive to JVM ping timeouts
This is useful for servers with high load.
# jRunner JVM timeout
jrunner.jvm_exit.timeout=60
jrunner.shutdown.timeout=120
jrunner.ping.interval=60
jrunner.ping.interval.logged=120
jrunner.ping.timeout=240
Using jrunner.logfile.rollmode
This property controls the roll mode of the log file. Refer to the samples below on how to name the log file to specify the roll number or date stamp in the log file name. Possible jrunner.logfile.rollmode values include:
NONE
In this mode, the log file will never be rolled by the Proxy Server. The log file will continue to grow in size indefinitely. Use for the cases, when you want to disable log rolling by the Proxy Server.
SIZE
In this mode, the log file will be rolled whenever its size exceeds the value defined by the jrunner.logfile.maxsize property:
maxsize property specifies maximum size that the log file will be allowed to grow to before the log is rolled. The value is specified in bytes. The default value of jrunner.logfile.maxsize=0, disables log rolling. The size can be abbreviated with the 'k' (kb) or 'm' (mb) suffix. For example: 10m = 10 megabytes.
WRAPPER
In this mode, the log file will be rolled when the Proxy Server is first launched. This rolling will happen immediately after the configuration file has been loaded. For this reason, any configuration problems will be logged to the file prior to it being rolled. In this WRAPPER mode, the log files will not have a maximum size and will continue to grow until the Proxy Server is restarted.
JVM
In this mode, the log file will be rolled on Proxy Server startup as with the WRAPPER mode. But it will also be rolled just before any restarted JVMs are launched. In this JVM mode, the log files will not have a maximum size and will continue to grow until the Proxy Server or a JVM is restarted.
SIZE_OR_WRAPPER
This mode combines the SIZE and WRAPPER modes. The log file will be rolled on Proxy Server startup or whenever the log file exceeds the configured maximum size.
SIZE_OR_JVM
This mode combines the SIZE and JVM modes. The log file will be rolled on Proxy Server startup, JVM restart, or whenever the log file exceeds the configured maximum size.
DATE
In this mode, as each log entry is logged to a file by date, its timestamp is compared with a "YYYYMMDD" formatted token in the current log file. Whenever this date changes a new log file will be created for logging. This has the benefit of grouping all log entries for a given day in a specific file. A file will not be created on days which do not have any log output. This roll mode requires that the jrunner.logfile property has the "YYYYMMDD" token located somewhere in the file name.
Sample: Using ROLLNUM token in the filename:
Using ROLLNUM token we can specify the position of the log file number version when it is rolled. The most recent file will have a roll number „1“, the second recent will have a roll number „2“ , etc.
If a ROLLNUM token is not included in the log file, ".ROLLNUM" will be appended at the end by default. To get this token working jrunner.logfile.rollmode property has to be in rolling mode.
Example:
jrunner.logfile.maxsize=10m
jrunner.logfile.rollmode=SIZE
jrunner.logfile=../logs/proxyserver-ROLLNUM.log
Sample: Using YYYYMMDD token in the filename:
Using YYYYMMDD token we can specify the position of the date stamp in the log file when it is rolled. This token is required when jrunner.logfile.rollmode property has a value of DATE.
Example:
jrunner.logfile.rollmode=DATE
jrunner.logfile=../logs/proxyserver-YYYYMMDD.log